<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module PySQLRClient</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>PySQLRClient</strong></big></big></font></td
><td align=right valign=bottom
></td></tr></table>
    <p><tt>#&nbsp;Copyright&nbsp;(c)&nbsp;2000&nbsp;Roman&nbsp;Milner<br>
#&nbsp;See&nbsp;the&nbsp;file&nbsp;COPYING&nbsp;for&nbsp;more&nbsp;information</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top>SQLRelay.CSQLRelay<br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="PySQLRClient.html#sqlrconnection">sqlrconnection</a>
</font></dt><dt><font face="helvetica, arial"><a href="PySQLRClient.html#sqlrcursor">sqlrcursor</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="sqlrconnection">class <strong>sqlrconnection</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#sqlrconnection">sqlrconnection</a>(host,&nbsp;port,&nbsp;socket,&nbsp;user,&nbsp;password,&nbsp;retrytime=0,&nbsp;tries=1)<br>
&nbsp;<br>
A&nbsp;wrapper&nbsp;for&nbsp;the&nbsp;sqlrelay&nbsp;connection&nbsp;API.&nbsp;&nbsp;Closely&nbsp;follows&nbsp;the&nbsp;C++&nbsp;API.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="sqlrconnection-__del__"><strong>__del__</strong></a>(self)</dt></dl>

<dl><dt><a name="sqlrconnection-__init__"><strong>__init__</strong></a>(self, host, port, socket, user, password, retrytime=0, tries=1)</dt><dd><tt>Opens&nbsp;a&nbsp;connection&nbsp;to&nbsp;the&nbsp;sqlrelay&nbsp;server&nbsp;and&nbsp;auths&nbsp;with<br>
user&nbsp;and&nbsp;password.&nbsp;&nbsp;Failed&nbsp;connections&nbsp;are&nbsp;retried&nbsp;for&nbsp;tries&nbsp;times,<br>
waiting&nbsp;retrytime&nbsp;seconds&nbsp;between&nbsp;each&nbsp;try.&nbsp;&nbsp;If&nbsp;tries&nbsp;is&nbsp;0&nbsp;then&nbsp;retries<br>
will&nbsp;continue&nbsp;forever.&nbsp;&nbsp;If&nbsp;retrytime&nbsp;is&nbsp;0&nbsp;then&nbsp;retries&nbsp;will&nbsp;be&nbsp;attempted<br>
on&nbsp;a&nbsp;default&nbsp;interval.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-autoCommitOff"><strong>autoCommitOff</strong></a>(self)</dt><dd><tt>Instructs&nbsp;the&nbsp;database&nbsp;to&nbsp;wait&nbsp;for&nbsp;the&nbsp;<br>
client&nbsp;to&nbsp;tell&nbsp;it&nbsp;when&nbsp;to&nbsp;commit.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-autoCommitOn"><strong>autoCommitOn</strong></a>(self)</dt><dd><tt>Instructs&nbsp;the&nbsp;database&nbsp;to&nbsp;perform&nbsp;a&nbsp;commit<br>
after&nbsp;every&nbsp;successful&nbsp;query.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-begin"><strong>begin</strong></a>(self)</dt><dd><tt>Begins&nbsp;a&nbsp;transaction.&nbsp;&nbsp;Returns&nbsp;true&nbsp;if&nbsp;the&nbsp;begin<br>
succeeded,&nbsp;false&nbsp;if&nbsp;it&nbsp;failed.&nbsp;&nbsp;If&nbsp;the&nbsp;database<br>
automatically&nbsp;begins&nbsp;a&nbsp;new&nbsp;transaction&nbsp;when&nbsp;a<br>
commit&nbsp;or&nbsp;rollback&nbsp;is&nbsp;issued&nbsp;then&nbsp;this&nbsp;doesn't<br>
do&nbsp;anything&nbsp;unless&nbsp;SQL&nbsp;Relay&nbsp;is&nbsp;faking&nbsp;transaction<br>
blocks.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-bindFormat"><strong>bindFormat</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;representing&nbsp;the&nbsp;format<br>
of&nbsp;the&nbsp;bind&nbsp;variables&nbsp;used&nbsp;in&nbsp;the&nbsp;db.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-clientVersion"><strong>clientVersion</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;version&nbsp;of&nbsp;the&nbsp;SQL&nbsp;Relay&nbsp;client&nbsp;version</tt></dd></dl>

<dl><dt><a name="sqlrconnection-commit"><strong>commit</strong></a>(self)</dt><dd><tt>Issues&nbsp;a&nbsp;commit,&nbsp;returns&nbsp;true&nbsp;if&nbsp;the&nbsp;commit<br>
succeeded,&nbsp;false&nbsp;if&nbsp;it&nbsp;failed.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-dbHostName"><strong>dbHostName</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;host&nbsp;name&nbsp;of&nbsp;the&nbsp;database</tt></dd></dl>

<dl><dt><a name="sqlrconnection-dbIpAddress"><strong>dbIpAddress</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;ip&nbsp;address&nbsp;of&nbsp;the&nbsp;database</tt></dd></dl>

<dl><dt><a name="sqlrconnection-dbVersion"><strong>dbVersion</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;version&nbsp;of&nbsp;the&nbsp;database</tt></dd></dl>

<dl><dt><a name="sqlrconnection-debugOff"><strong>debugOff</strong></a>(self)</dt><dd><tt>Turn&nbsp;verbose&nbsp;debugging&nbsp;off.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-debugOn"><strong>debugOn</strong></a>(self)</dt><dd><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Turn&nbsp;verbose&nbsp;debugging&nbsp;on.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Another&nbsp;way&nbsp;to&nbsp;do&nbsp;this&nbsp;is&nbsp;to&nbsp;start&nbsp;a&nbsp;query&nbsp;with&nbsp;"--&nbsp;debug<br>
".<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Yet&nbsp;another&nbsp;way&nbsp;is&nbsp;to&nbsp;set&nbsp;the&nbsp;environment&nbsp;variable&nbsp;SQLR_CLIENT_DEBUG<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to&nbsp;"ON"</tt></dd></dl>

<dl><dt><a name="sqlrconnection-disableEncryption"><strong>disableEncryption</strong></a>(self)</dt><dd><tt>Disables&nbsp;encryption.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-enableKerberos"><strong>enableKerberos</strong></a>(self, service, mech, flags)</dt><dd><tt>Enables&nbsp;Kerberos&nbsp;authentication&nbsp;and&nbsp;encryption.<br>
&nbsp;<br>
"service"&nbsp;indicates&nbsp;the&nbsp;Kerberos&nbsp;service&nbsp;name&nbsp;of&nbsp;the<br>
SQL&nbsp;Relay&nbsp;server.&nbsp;&nbsp;If&nbsp;left&nbsp;empty&nbsp;or&nbsp;NULL&nbsp;then&nbsp;the&nbsp;service<br>
name&nbsp;"sqlrelay"&nbsp;will&nbsp;be&nbsp;used.&nbsp;"sqlrelay"&nbsp;is&nbsp;the&nbsp;default<br>
service&nbsp;name&nbsp;of&nbsp;the&nbsp;SQL&nbsp;Relay&nbsp;server.&nbsp;&nbsp;Note&nbsp;that&nbsp;on&nbsp;Windows<br>
platforms&nbsp;the&nbsp;service&nbsp;name&nbsp;must&nbsp;be&nbsp;fully&nbsp;qualified,<br>
including&nbsp;the&nbsp;host&nbsp;and&nbsp;realm&nbsp;name.&nbsp;&nbsp;For&nbsp;example:<br>
"sqlrelay/sqlrserver.firstworks.com@AD.FIRSTWORKS.COM".<br>
&nbsp;<br>
"mech"&nbsp;indicates&nbsp;the&nbsp;specific&nbsp;Kerberos&nbsp;mechanism&nbsp;to&nbsp;use.<br>
On&nbsp;Linux/Unix&nbsp;platforms,&nbsp;this&nbsp;should&nbsp;be&nbsp;a&nbsp;string<br>
representation&nbsp;of&nbsp;the&nbsp;mechnaism's&nbsp;OID,&nbsp;such&nbsp;as:<br>
&nbsp;&nbsp;&nbsp;&nbsp;{&nbsp;1&nbsp;2&nbsp;840&nbsp;113554&nbsp;1&nbsp;2&nbsp;2&nbsp;}<br>
On&nbsp;Windows&nbsp;platforms,&nbsp;this&nbsp;should&nbsp;be&nbsp;a&nbsp;string&nbsp;like:<br>
&nbsp;&nbsp;&nbsp;&nbsp;Kerberos<br>
If&nbsp;left&nbsp;empty&nbsp;or&nbsp;NULL&nbsp;then&nbsp;the&nbsp;default&nbsp;mechanism&nbsp;will&nbsp;be<br>
used.&nbsp;&nbsp;Only&nbsp;set&nbsp;this&nbsp;if&nbsp;you&nbsp;know&nbsp;that&nbsp;you&nbsp;have&nbsp;a&nbsp;good<br>
reason&nbsp;to.<br>
&nbsp;<br>
"flags"&nbsp;indicates&nbsp;what&nbsp;Kerberos&nbsp;flags&nbsp;to&nbsp;use.&nbsp;&nbsp;Multiple<br>
flags&nbsp;may&nbsp;be&nbsp;specified,&nbsp;separated&nbsp;by&nbsp;commas.&nbsp;&nbsp;If&nbsp;left<br>
empty&nbsp;or&nbsp;NULL&nbsp;then&nbsp;a&nbsp;defalt&nbsp;set&nbsp;of&nbsp;flags&nbsp;will&nbsp;be&nbsp;used.<br>
Only&nbsp;set&nbsp;this&nbsp;if&nbsp;you&nbsp;know&nbsp;that&nbsp;you&nbsp;have&nbsp;a&nbsp;good&nbsp;reason&nbsp;to.<br>
&nbsp;<br>
Valid&nbsp;flags&nbsp;include:<br>
&nbsp;*&nbsp;GSS_C_MUTUAL_FLAG<br>
&nbsp;*&nbsp;GSS_C_REPLAY_FLAG<br>
&nbsp;*&nbsp;GSS_C_SEQUENCE_FLAG<br>
&nbsp;*&nbsp;GSS_C_CONF_FLAG<br>
&nbsp;*&nbsp;GSS_C_INTEG_FLAG<br>
&nbsp;<br>
For&nbsp;a&nbsp;full&nbsp;list&nbsp;of&nbsp;flags,&nbsp;consult&nbsp;the&nbsp;GSSAPI&nbsp;documentation,<br>
though&nbsp;note&nbsp;that&nbsp;only&nbsp;the&nbsp;flags&nbsp;listed&nbsp;above&nbsp;are&nbsp;supported<br>
on&nbsp;Windows.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-enableTls"><strong>enableTls</strong></a>(self, version, cert, password, ciphers, validate, ca, depth)</dt><dd><tt>Enables&nbsp;TLS/SSL&nbsp;encryption,&nbsp;and&nbsp;optionally&nbsp;authentication.<br>
&nbsp;<br>
"version"&nbsp;specifies&nbsp;the&nbsp;TLS/SSL&nbsp;protocol&nbsp;version&nbsp;that&nbsp;the<br>
client&nbsp;will&nbsp;attempt&nbsp;to&nbsp;use.&nbsp;&nbsp;Valid&nbsp;values&nbsp;include&nbsp;SSL2,<br>
SSL3,&nbsp;TLS1,&nbsp;TLS1.1,&nbsp;TLS1.2&nbsp;or&nbsp;any&nbsp;more&nbsp;recent&nbsp;version&nbsp;of<br>
TLS,&nbsp;as&nbsp;supported&nbsp;by&nbsp;and&nbsp;enabled&nbsp;in&nbsp;the&nbsp;underlying&nbsp;TLS/SSL<br>
library.&nbsp;&nbsp;If&nbsp;left&nbsp;blank&nbsp;or&nbsp;empty&nbsp;then&nbsp;the&nbsp;highest&nbsp;supported<br>
version&nbsp;will&nbsp;be&nbsp;negotiated.<br>
&nbsp;<br>
"cert"&nbsp;is&nbsp;the&nbsp;file&nbsp;name&nbsp;of&nbsp;the&nbsp;certificate&nbsp;chain&nbsp;file&nbsp;to<br>
send&nbsp;to&nbsp;the&nbsp;SQL&nbsp;Relay&nbsp;server.&nbsp;&nbsp;This&nbsp;is&nbsp;only&nbsp;necessary&nbsp;if<br>
the&nbsp;SQL&nbsp;Relay&nbsp;server&nbsp;is&nbsp;configured&nbsp;to&nbsp;authenticate&nbsp;and<br>
authorize&nbsp;clients&nbsp;by&nbsp;certificate.<br>
&nbsp;<br>
If&nbsp;"cert"&nbsp;contains&nbsp;a&nbsp;password-protected&nbsp;private&nbsp;key,&nbsp;then<br>
"password"&nbsp;may&nbsp;be&nbsp;supplied&nbsp;to&nbsp;access&nbsp;it.&nbsp;&nbsp;If&nbsp;the&nbsp;private<br>
key&nbsp;is&nbsp;not&nbsp;password-protected,&nbsp;then&nbsp;this&nbsp;argument&nbsp;is<br>
ignored,&nbsp;and&nbsp;may&nbsp;be&nbsp;left&nbsp;empty&nbsp;or&nbsp;NULL.<br>
&nbsp;<br>
"ciphers"&nbsp;is&nbsp;a&nbsp;list&nbsp;of&nbsp;ciphers&nbsp;to&nbsp;allow.&nbsp;&nbsp;Ciphers&nbsp;may&nbsp;be<br>
separated&nbsp;by&nbsp;spaces,&nbsp;commas,&nbsp;or&nbsp;colons.&nbsp;&nbsp;If&nbsp;"ciphers"&nbsp;is<br>
empty&nbsp;or&nbsp;NULL&nbsp;then&nbsp;a&nbsp;default&nbsp;set&nbsp;is&nbsp;used.&nbsp;&nbsp;Only&nbsp;set&nbsp;this&nbsp;if<br>
you&nbsp;know&nbsp;that&nbsp;you&nbsp;have&nbsp;a&nbsp;good&nbsp;reason&nbsp;to.<br>
&nbsp;<br>
For&nbsp;a&nbsp;list&nbsp;of&nbsp;valid&nbsp;ciphers&nbsp;on&nbsp;Linux/Unix&nbsp;platforms,&nbsp;see:<br>
&nbsp;&nbsp;&nbsp;&nbsp;man&nbsp;ciphers<br>
&nbsp;<br>
For&nbsp;a&nbsp;list&nbsp;of&nbsp;valid&nbsp;ciphers&nbsp;on&nbsp;Windows&nbsp;platforms,&nbsp;see:<br>
&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://msdn.microsoft.com/en-us/library/windows/desktop/aa375549%28v=vs.85%29.aspx">https://msdn.microsoft.com/en-us/library/windows/desktop/aa375549%28v=vs.85%29.aspx</a><br>
On&nbsp;Windows&nbsp;platforms,&nbsp;the&nbsp;ciphers&nbsp;(alg_id's)&nbsp;should&nbsp;omit<br>
CALG_&nbsp;and&nbsp;may&nbsp;be&nbsp;given&nbsp;with&nbsp;underscores&nbsp;or&nbsp;dashes.<br>
For&nbsp;example:&nbsp;3DES_112<br>
&nbsp;<br>
"validate"&nbsp;indicates&nbsp;whether&nbsp;to&nbsp;validate&nbsp;the&nbsp;SQL&nbsp;Relay's<br>
server&nbsp;certificate,&nbsp;and&nbsp;may&nbsp;be&nbsp;set&nbsp;to&nbsp;one&nbsp;of&nbsp;the&nbsp;following:<br>
&nbsp;&nbsp;&nbsp;&nbsp;"no"&nbsp;-&nbsp;Don't&nbsp;validate&nbsp;the&nbsp;server's&nbsp;certificate.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"ca"&nbsp;-&nbsp;Validate&nbsp;that&nbsp;the&nbsp;server's&nbsp;certificate&nbsp;was<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;signed&nbsp;by&nbsp;a&nbsp;trusted&nbsp;certificate&nbsp;authority.<br>
&nbsp;&nbsp;&nbsp;&nbsp;"ca+host"&nbsp;-&nbsp;Perform&nbsp;"ca"&nbsp;validation&nbsp;and&nbsp;also&nbsp;validate<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;that&nbsp;one&nbsp;of&nbsp;the&nbsp;subject&nbsp;altenate&nbsp;names&nbsp;(or&nbsp;the<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;common&nbsp;name&nbsp;if&nbsp;no&nbsp;SANs&nbsp;are&nbsp;present)&nbsp;in&nbsp;the<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;certificate&nbsp;matches&nbsp;the&nbsp;host&nbsp;parameter.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(Falls&nbsp;back&nbsp;to&nbsp;"ca"&nbsp;validation&nbsp;when&nbsp;a&nbsp;unix<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;socket&nbsp;is&nbsp;used.)<br>
&nbsp;&nbsp;&nbsp;&nbsp;"ca+domain"&nbsp;-&nbsp;Perform&nbsp;"ca"&nbsp;validation&nbsp;and&nbsp;also&nbsp;validate<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;that&nbsp;the&nbsp;domain&nbsp;name&nbsp;of&nbsp;one&nbsp;of&nbsp;the&nbsp;subject<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;alternate&nbsp;names&nbsp;(or&nbsp;the&nbsp;common&nbsp;name&nbsp;if&nbsp;no&nbsp;SANs<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;are&nbsp;present)&nbsp;in&nbsp;the&nbsp;certificate&nbsp;matches&nbsp;the<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;domain&nbsp;name&nbsp;of&nbsp;the&nbsp;host&nbsp;parameter.&nbsp;&nbsp;(Falls&nbsp;back<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to&nbsp;"ca"&nbsp;validation&nbsp;when&nbsp;a&nbsp;unix&nbsp;socket&nbsp;is&nbsp;used.)<br>
&nbsp;<br>
"ca"&nbsp;is&nbsp;the&nbsp;location&nbsp;of&nbsp;a&nbsp;certificate&nbsp;authority&nbsp;file&nbsp;to<br>
use,&nbsp;in&nbsp;addition&nbsp;to&nbsp;the&nbsp;system's&nbsp;root&nbsp;certificates,&nbsp;when<br>
validating&nbsp;the&nbsp;SQL&nbsp;Relay&nbsp;server's&nbsp;certificate.&nbsp;&nbsp;This&nbsp;is<br>
useful&nbsp;if&nbsp;the&nbsp;SQL&nbsp;Relay&nbsp;server's&nbsp;certificate&nbsp;is&nbsp;self-signed.<br>
&nbsp;<br>
On&nbsp;Windows,&nbsp;"ca"&nbsp;must&nbsp;be&nbsp;a&nbsp;file&nbsp;name.<br>
&nbsp;<br>
On&nbsp;non-Windows&nbsp;systems,&nbsp;"ca"&nbsp;can&nbsp;be&nbsp;either&nbsp;a&nbsp;file&nbsp;or<br>
directory&nbsp;name.&nbsp;&nbsp;If&nbsp;it&nbsp;is&nbsp;a&nbsp;directory&nbsp;name,&nbsp;then&nbsp;all<br>
certificate&nbsp;authority&nbsp;files&nbsp;found&nbsp;in&nbsp;that&nbsp;directory&nbsp;will&nbsp;be<br>
used.&nbsp;&nbsp;If&nbsp;it&nbsp;a&nbsp;file&nbsp;name,&nbsp;then&nbsp;only&nbsp;that&nbsp;file&nbsp;will&nbsp;be&nbsp;used.<br>
&nbsp;<br>
&nbsp;<br>
Note&nbsp;that&nbsp;the&nbsp;supported&nbsp;"cert"&nbsp;and&nbsp;"ca"&nbsp;file&nbsp;formats&nbsp;may<br>
vary&nbsp;between&nbsp;platforms.&nbsp;&nbsp;A&nbsp;variety&nbsp;of&nbsp;file&nbsp;formats&nbsp;are<br>
generally&nbsp;supported&nbsp;on&nbsp;Linux/Unix&nbsp;platfoms&nbsp;(.pem,&nbsp;.pfx,<br>
etc.)&nbsp;but&nbsp;only&nbsp;the&nbsp;.pfx&nbsp;format&nbsp;is&nbsp;currently&nbsp;supported&nbsp;on<br>
Windows.&nbsp;*/</tt></dd></dl>

<dl><dt><a name="sqlrconnection-endSession"><strong>endSession</strong></a>(self)</dt><dd><tt>Ends&nbsp;the&nbsp;current&nbsp;session.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-errorMessage"><strong>errorMessage</strong></a>(self)</dt><dd><tt>If&nbsp;the&nbsp;operation&nbsp;failed,&nbsp;the&nbsp;error&nbsp;message&nbsp;will&nbsp;be&nbsp;returned<br>
from&nbsp;this&nbsp;method.&nbsp;&nbsp;Otherwise,&nbsp;it&nbsp;returns&nbsp;None.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-errorNumber"><strong>errorNumber</strong></a>(self)</dt><dd><tt>If&nbsp;an&nbsp;operation&nbsp;failed&nbsp;and&nbsp;generated&nbsp;an<br>
error,&nbsp;the&nbsp;error&nbsp;number&nbsp;is&nbsp;available&nbsp;here.<br>
If&nbsp;there&nbsp;is&nbsp;no&nbsp;error&nbsp;then&nbsp;this&nbsp;method&nbsp;<br>
returns&nbsp;0.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getBindVariableDelimiterAtSignSupported"><strong>getBindVariableDelimiterAtSignSupported</strong></a>(self)</dt><dd><tt>Returns&nbsp;true&nbsp;if&nbsp;at-signs&nbsp;(@)&nbsp;are&nbsp;considered&nbsp;to&nbsp;be<br>
valid&nbsp;bind&nbsp;variable&nbsp;delimiters.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getBindVariableDelimiterColonSupported"><strong>getBindVariableDelimiterColonSupported</strong></a>(self)</dt><dd><tt>Returns&nbsp;true&nbsp;if&nbsp;colons&nbsp;(:)&nbsp;are&nbsp;considered&nbsp;to&nbsp;be<br>
valid&nbsp;bind&nbsp;variable&nbsp;delimiters.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getBindVariableDelimiterDollarSignSupported"><strong>getBindVariableDelimiterDollarSignSupported</strong></a>(self)</dt><dd><tt>Returns&nbsp;true&nbsp;if&nbsp;dollar&nbsp;signs&nbsp;($)&nbsp;are&nbsp;considered&nbsp;to&nbsp;be<br>
valid&nbsp;bind&nbsp;variable&nbsp;delimiters.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getBindVariableDelimiterQuestionMarkSupported"><strong>getBindVariableDelimiterQuestionMarkSupported</strong></a>(self)</dt><dd><tt>Returns&nbsp;true&nbsp;if&nbsp;question&nbsp;marks&nbsp;(?)&nbsp;are&nbsp;considered&nbsp;to&nbsp;be<br>
valid&nbsp;bind&nbsp;variable&nbsp;delimiters.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getClientInfo"><strong>getClientInfo</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;string&nbsp;that&nbsp;was&nbsp;set&nbsp;by&nbsp;<a href="#sqlrconnection-setClientInfo">setClientInfo</a>().</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getConnectionPort"><strong>getConnectionPort</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;inet&nbsp;port&nbsp;that&nbsp;the&nbsp;connection&nbsp;is&nbsp;<br>
communicating&nbsp;over.&nbsp;This&nbsp;parameter&nbsp;may&nbsp;be&nbsp;<br>
passed&nbsp;to&nbsp;another&nbsp;connection&nbsp;for&nbsp;use&nbsp;in<br>
the&nbsp;<a href="#sqlrconnection-resumeSession">resumeSession</a>()&nbsp;method.<br>
Note:&nbsp;the&nbsp;value&nbsp;returned&nbsp;by&nbsp;this&nbsp;method&nbsp;is<br>
only&nbsp;valid&nbsp;after&nbsp;a&nbsp;call&nbsp;to&nbsp;<a href="#sqlrconnection-suspendSession">suspendSession</a>().</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getConnectionSocket"><strong>getConnectionSocket</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;unix&nbsp;socket&nbsp;that&nbsp;the&nbsp;connection&nbsp;is&nbsp;<br>
communicating&nbsp;over.&nbsp;This&nbsp;parameter&nbsp;may&nbsp;be&nbsp;<br>
passed&nbsp;to&nbsp;another&nbsp;connection&nbsp;for&nbsp;use&nbsp;in<br>
the&nbsp;<a href="#sqlrconnection-resumeSession">resumeSession</a>()&nbsp;method.<br>
Note:&nbsp;the&nbsp;value&nbsp;returned&nbsp;by&nbsp;this&nbsp;method&nbsp;is<br>
only&nbsp;valid&nbsp;after&nbsp;a&nbsp;call&nbsp;to&nbsp;<a href="#sqlrconnection-suspendSession">suspendSession</a>().</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getCurrentDatabase"><strong>getCurrentDatabase</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;database/schema&nbsp;that&nbsp;is&nbsp;currently&nbsp;in&nbsp;use.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getDebug"><strong>getDebug</strong></a>(self)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;debugging&nbsp;is&nbsp;turned&nbsp;on&nbsp;and&nbsp;0&nbsp;if&nbsp;debugging&nbsp;is&nbsp;turned&nbsp;off.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-getLastInsertId"><strong>getLastInsertId</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;autoincrement&nbsp;column&nbsp;for&nbsp;the&nbsp;last&nbsp;insert</tt></dd></dl>

<dl><dt><a name="sqlrconnection-identify"><strong>identify</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;type&nbsp;of&nbsp;database:&nbsp;<br>
&nbsp;&nbsp;oracle,&nbsp;postgresql,&nbsp;mysql,&nbsp;etc.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-nextvalFormat"><strong>nextvalFormat</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;string&nbsp;representing&nbsp;the&nbsp;format&nbsp;of&nbsp;the<br>
sequence&nbsp;nextval&nbsp;command&nbsp;used&nbsp;in&nbsp;the&nbsp;db.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-ping"><strong>ping</strong></a>(self)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;database&nbsp;is&nbsp;up&nbsp;and&nbsp;0<br>
if&nbsp;it's&nbsp;down.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-resumeSession"><strong>resumeSession</strong></a>(self, port, socket)</dt><dd><tt>Resumes&nbsp;a&nbsp;session&nbsp;previously&nbsp;left&nbsp;open&nbsp;<br>
using&nbsp;<a href="#sqlrconnection-suspendSession">suspendSession</a>().<br>
Returns&nbsp;1&nbsp;on&nbsp;success&nbsp;and&nbsp;0&nbsp;on&nbsp;failure.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-rollback"><strong>rollback</strong></a>(self)</dt><dd><tt>Issues&nbsp;a&nbsp;rollback,&nbsp;returns&nbsp;true&nbsp;if&nbsp;the&nbsp;rollback<br>
succeeded,&nbsp;false&nbsp;if&nbsp;it&nbsp;failed.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-selectDatabase"><strong>selectDatabase</strong></a>(self, database)</dt><dd><tt>Sets&nbsp;the&nbsp;current&nbsp;database/schema&nbsp;to&nbsp;"database"</tt></dd></dl>

<dl><dt><a name="sqlrconnection-serverVersion"><strong>serverVersion</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;version&nbsp;of&nbsp;the&nbsp;SQL&nbsp;Relay&nbsp;server&nbsp;version</tt></dd></dl>

<dl><dt><a name="sqlrconnection-setBindVariableDelimiters"><strong>setBindVariableDelimiters</strong></a>(self, delimiters)</dt><dd><tt>Sets&nbsp;which&nbsp;delimiters&nbsp;are&nbsp;used&nbsp;to&nbsp;identify&nbsp;bind&nbsp;variables<br>
in&nbsp;countBindVariables()&nbsp;and&nbsp;validateBinds().&nbsp;&nbsp;Valid<br>
delimiters&nbsp;include&nbsp;?,:,@,&nbsp;and&nbsp;$.&nbsp;&nbsp;Defaults&nbsp;to&nbsp;"?:@$"</tt></dd></dl>

<dl><dt><a name="sqlrconnection-setClientInfo"><strong>setClientInfo</strong></a>(self, clientinfo)</dt><dd><tt>Allows&nbsp;you&nbsp;to&nbsp;set&nbsp;a&nbsp;string&nbsp;that&nbsp;will&nbsp;be&nbsp;passed&nbsp;to&nbsp;the<br>
server&nbsp;and&nbsp;ultimately&nbsp;included&nbsp;in&nbsp;server-side&nbsp;logging<br>
along&nbsp;with&nbsp;queries&nbsp;that&nbsp;were&nbsp;run&nbsp;by&nbsp;this&nbsp;instance&nbsp;of<br>
the&nbsp;client.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-setConnectTimeout"><strong>setConnectTimeout</strong></a>(self, timeoutsec, timeoutusec)</dt><dd><tt>Sets&nbsp;the&nbsp;server&nbsp;connect&nbsp;timeout&nbsp;in&nbsp;seconds&nbsp;and<br>
milliseconds.&nbsp;&nbsp;Setting&nbsp;either&nbsp;parameter&nbsp;to&nbsp;-1&nbsp;disables&nbsp;the<br>
timeout.&nbsp;&nbsp;You&nbsp;can&nbsp;also&nbsp;set&nbsp;this&nbsp;timeout&nbsp;using&nbsp;the<br>
SQLR_CLIENT_CONNECT_TIMEOUT&nbsp;environment&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-setDebugFile"><strong>setDebugFile</strong></a>(self, filename)</dt><dd><tt>Allows&nbsp;you&nbsp;to&nbsp;specify&nbsp;a&nbsp;file&nbsp;to&nbsp;write&nbsp;debug&nbsp;to.<br>
Setting&nbsp;"filename"&nbsp;to&nbsp;NULL&nbsp;or&nbsp;an&nbsp;empty&nbsp;string&nbsp;causes&nbsp;debug<br>
to&nbsp;be&nbsp;written&nbsp;to&nbsp;standard&nbsp;output&nbsp;(the&nbsp;default).</tt></dd></dl>

<dl><dt><a name="sqlrconnection-setResponseTimeout"><strong>setResponseTimeout</strong></a>(self, timeoutsec, timeoutusec)</dt><dd><tt>Sets&nbsp;the&nbsp;response&nbsp;timeout&nbsp;(for&nbsp;queries,&nbsp;commits,&nbsp;rollbacks,<br>
pings,&nbsp;etc.)&nbsp;in&nbsp;seconds&nbsp;and&nbsp;milliseconds.&nbsp;&nbsp;Setting&nbsp;either<br>
parameter&nbsp;to&nbsp;-1&nbsp;disables&nbsp;the&nbsp;timeout.&nbsp;&nbsp;You&nbsp;can&nbsp;also&nbsp;set<br>
this&nbsp;timeout&nbsp;using&nbsp;the&nbsp;SQLR_CLIENT_RESPONSE_TIMEOUT<br>
environment&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrconnection-suspendSession"><strong>suspendSession</strong></a>(self)</dt><dd><tt>Disconnects&nbsp;this&nbsp;connection&nbsp;from&nbsp;the&nbsp;current<br>
session&nbsp;but&nbsp;leaves&nbsp;the&nbsp;session&nbsp;open&nbsp;so&nbsp;<br>
that&nbsp;another&nbsp;connection&nbsp;can&nbsp;connect&nbsp;to&nbsp;it&nbsp;<br>
using&nbsp;<a href="#sqlrconnection-resumeSession">resumeSession</a>().</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="sqlrcursor">class <strong>sqlrcursor</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#sqlrcursor">sqlrcursor</a>(sqlrcon)<br>
&nbsp;<br>
A&nbsp;wrapper&nbsp;for&nbsp;the&nbsp;sqlrelay&nbsp;cursor&nbsp;API.&nbsp;&nbsp;Closely&nbsp;follows&nbsp;the&nbsp;C++&nbsp;API.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="sqlrcursor-__del__"><strong>__del__</strong></a>(self)</dt></dl>

<dl><dt><a name="sqlrcursor-__init__"><strong>__init__</strong></a>(self, sqlrcon)</dt><dd><tt>Initialize&nbsp;self.&nbsp;&nbsp;See&nbsp;help(type(self))&nbsp;for&nbsp;accurate&nbsp;signature.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-affectedRows"><strong>affectedRows</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;that&nbsp;were&nbsp;<br>
updated,&nbsp;inserted&nbsp;or&nbsp;deleted&nbsp;by&nbsp;the&nbsp;query.<br>
Not&nbsp;all&nbsp;databases&nbsp;support&nbsp;this&nbsp;call.&nbsp;&nbsp;Don't&nbsp;<br>
use&nbsp;it&nbsp;for&nbsp;applications&nbsp;which&nbsp;are&nbsp;designed&nbsp;<br>
to&nbsp;be&nbsp;portable&nbsp;across&nbsp;databases.&nbsp;&nbsp;-1&nbsp;is&nbsp;<br>
returned&nbsp;by&nbsp;databases&nbsp;which&nbsp;don't&nbsp;support&nbsp;<br>
this&nbsp;option.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-cacheOff"><strong>cacheOff</strong></a>(self)</dt><dd><tt>Sets&nbsp;query&nbsp;caching&nbsp;off.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-cacheToFile"><strong>cacheToFile</strong></a>(self, filename)</dt><dd><tt>Sets&nbsp;query&nbsp;caching&nbsp;on.&nbsp;&nbsp;Future&nbsp;queries<br>
will&nbsp;be&nbsp;cached&nbsp;to&nbsp;the&nbsp;file&nbsp;"filename".<br>
The&nbsp;full&nbsp;pathname&nbsp;of&nbsp;the&nbsp;file&nbsp;can&nbsp;be<br>
retrieved&nbsp;using&nbsp;<a href="#sqlrcursor-getCacheFileName">getCacheFileName</a>().<br>
&nbsp;<br>
A&nbsp;default&nbsp;time-to-live&nbsp;of&nbsp;10&nbsp;minutes&nbsp;is<br>
also&nbsp;set.<br>
&nbsp;<br>
Note&nbsp;that&nbsp;once&nbsp;<a href="#sqlrcursor-cacheToFile">cacheToFile</a>()&nbsp;is&nbsp;called,<br>
the&nbsp;result&nbsp;sets&nbsp;of&nbsp;all&nbsp;future&nbsp;queries&nbsp;will<br>
be&nbsp;cached&nbsp;to&nbsp;that&nbsp;file&nbsp;until&nbsp;another&nbsp;call&nbsp;<br>
to&nbsp;<a href="#sqlrcursor-cacheToFile">cacheToFile</a>()&nbsp;changes&nbsp;which&nbsp;file&nbsp;to<br>
cache&nbsp;to&nbsp;or&nbsp;a&nbsp;call&nbsp;to&nbsp;<a href="#sqlrcursor-cacheOff">cacheOff</a>()&nbsp;turns&nbsp;off<br>
caching.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-clearBinds"><strong>clearBinds</strong></a>(self)</dt><dd><tt>Clear&nbsp;all&nbsp;binds&nbsp;variables.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-closeResultSet"><strong>closeResultSet</strong></a>()</dt><dd><tt>Closes&nbsp;the&nbsp;current&nbsp;result&nbsp;set,&nbsp;if&nbsp;one&nbsp;is&nbsp;open.&nbsp;&nbsp;Data<br>
that&nbsp;has&nbsp;been&nbsp;fetched&nbsp;already&nbsp;is&nbsp;still&nbsp;available&nbsp;but<br>
no&nbsp;more&nbsp;data&nbsp;may&nbsp;be&nbsp;fetched.&nbsp;&nbsp;Server&nbsp;side&nbsp;resources<br>
for&nbsp;the&nbsp;result&nbsp;set&nbsp;are&nbsp;freed&nbsp;as&nbsp;well.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-colCount"><strong>colCount</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;number&nbsp;of&nbsp;columns&nbsp;in&nbsp;the&nbsp;current&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-countBindVariables"><strong>countBindVariables</strong></a>(self)</dt><dd><tt>Parses&nbsp;the&nbsp;previously&nbsp;prepared&nbsp;query,<br>
counts&nbsp;the&nbsp;number&nbsp;of&nbsp;bind&nbsp;variables&nbsp;defined<br>
in&nbsp;it&nbsp;and&nbsp;returns&nbsp;that&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-defineOutputBindBlob"><strong>defineOutputBindBlob</strong></a>(self, variable)</dt><dd><tt>Define&nbsp;an&nbsp;output&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-defineOutputBindClob"><strong>defineOutputBindClob</strong></a>(self, variable)</dt><dd><tt>Define&nbsp;an&nbsp;output&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-defineOutputBindCursor"><strong>defineOutputBindCursor</strong></a>(self, variable)</dt><dd><tt>Define&nbsp;an&nbsp;output&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-defineOutputBindDouble"><strong>defineOutputBindDouble</strong></a>(self, variable)</dt><dd><tt>Define&nbsp;a&nbsp;double&nbsp;precision&nbsp;floating&nbsp;point&nbsp;output&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-defineOutputBindInteger"><strong>defineOutputBindInteger</strong></a>(self, variable)</dt><dd><tt>Define&nbsp;an&nbsp;integer&nbsp;output&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-defineOutputBindString"><strong>defineOutputBindString</strong></a>(self, variable, length)</dt><dd><tt>Define&nbsp;a&nbsp;string&nbsp;output&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-dontGetColumnInfo"><strong>dontGetColumnInfo</strong></a>(self)</dt><dd><tt>Tells&nbsp;the&nbsp;server&nbsp;not&nbsp;to&nbsp;send&nbsp;any&nbsp;column<br>
info&nbsp;(names,&nbsp;types,&nbsp;sizes).&nbsp;&nbsp;If&nbsp;you&nbsp;don't<br>
need&nbsp;that&nbsp;info,&nbsp;you&nbsp;should&nbsp;call&nbsp;this<br>
method&nbsp;to&nbsp;improve&nbsp;performance.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-endOfResultSet"><strong>endOfResultSet</strong></a>(self)</dt><dd><tt>Returns&nbsp;0&nbsp;if&nbsp;part&nbsp;of&nbsp;the&nbsp;result&nbsp;set&nbsp;is&nbsp;still<br>
pending&nbsp;on&nbsp;the&nbsp;server&nbsp;and&nbsp;1&nbsp;if&nbsp;not.&nbsp;&nbsp;This<br>
method&nbsp;can&nbsp;only&nbsp;return&nbsp;0&nbsp;if&nbsp;<br>
<a href="#sqlrcursor-setResultSetBufferSize">setResultSetBufferSize</a>()&nbsp;has&nbsp;been&nbsp;called<br>
with&nbsp;a&nbsp;parameter&nbsp;other&nbsp;than&nbsp;0.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-errorMessage"><strong>errorMessage</strong></a>(self)</dt><dd><tt>If&nbsp;the&nbsp;query&nbsp;failed,&nbsp;the&nbsp;error&nbsp;message&nbsp;will&nbsp;be&nbsp;returned<br>
from&nbsp;this&nbsp;method.&nbsp;&nbsp;Otherwise,&nbsp;it&nbsp;returns&nbsp;None.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-errorNumber"><strong>errorNumber</strong></a>(self)</dt><dd><tt>If&nbsp;the&nbsp;query&nbsp;failed&nbsp;and&nbsp;generated&nbsp;an<br>
error,&nbsp;the&nbsp;error&nbsp;number&nbsp;is&nbsp;available&nbsp;here.<br>
If&nbsp;there&nbsp;is&nbsp;no&nbsp;error&nbsp;then&nbsp;this&nbsp;method&nbsp;<br>
returns&nbsp;0.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-executeQuery"><strong>executeQuery</strong></a>(self)</dt><dd><tt>Execute&nbsp;the&nbsp;query&nbsp;that&nbsp;was&nbsp;previously<br>
prepared&nbsp;and&nbsp;bound.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-fetchFromBindCursor"><strong>fetchFromBindCursor</strong></a>(self)</dt><dd><tt>Fetch&nbsp;from&nbsp;a&nbsp;cursor&nbsp;that&nbsp;was&nbsp;returned&nbsp;as<br>
an&nbsp;output&nbsp;bind&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-firstRowIndex"><strong>firstRowIndex</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;index&nbsp;of&nbsp;the&nbsp;first&nbsp;buffered&nbsp;row.<br>
This&nbsp;is&nbsp;useful&nbsp;when&nbsp;buffering&nbsp;only&nbsp;part&nbsp;of<br>
the&nbsp;result&nbsp;set&nbsp;at&nbsp;a&nbsp;time.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getCacheFileName"><strong>getCacheFileName</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;name&nbsp;of&nbsp;the&nbsp;file&nbsp;containing&nbsp;the&nbsp;most<br>
recently&nbsp;cached&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnInfo"><strong>getColumnInfo</strong></a>(self)</dt><dd><tt>Tells&nbsp;the&nbsp;server&nbsp;to&nbsp;send&nbsp;column&nbsp;info.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsAutoIncrement"><strong>getColumnIsAutoIncrement</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;auto-increments&nbsp;and<br>
0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsBinary"><strong>getColumnIsBinary</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;contains&nbsp;binary&nbsp;data<br>
and&nbsp;0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsNullable"><strong>getColumnIsNullable</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;can&nbsp;contain&nbsp;nulls&nbsp;and<br>
0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsPartOfKey"><strong>getColumnIsPartOfKey</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;is&nbsp;part&nbsp;of&nbsp;a&nbsp;composite<br>
key&nbsp;and&nbsp;0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsPrimaryKey"><strong>getColumnIsPrimaryKey</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;is&nbsp;a&nbsp;primary&nbsp;key&nbsp;and<br>
0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsUnique"><strong>getColumnIsUnique</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;is&nbsp;unique&nbsp;and<br>
0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsUnsigned"><strong>getColumnIsUnsigned</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;is&nbsp;an&nbsp;unsigned&nbsp;number<br>
and&nbsp;0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnIsZeroFilled"><strong>getColumnIsZeroFilled</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;1&nbsp;if&nbsp;the&nbsp;specified&nbsp;column&nbsp;was&nbsp;created&nbsp;with&nbsp;the<br>
zero-fill&nbsp;flag&nbsp;and&nbsp;0&nbsp;otherwise.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnLength"><strong>getColumnLength</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;the&nbsp;length&nbsp;of&nbsp;the&nbsp;specified&nbsp;column.&nbsp;&nbsp;col&nbsp;may<br>
be&nbsp;a&nbsp;name&nbsp;or&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnList"><strong>getColumnList</strong></a>(sefl, table, wild)</dt><dd><tt>Sends&nbsp;a&nbsp;query&nbsp;that&nbsp;returns&nbsp;a&nbsp;list&nbsp;of&nbsp;columns<br>
in&nbsp;the&nbsp;table&nbsp;specified&nbsp;by&nbsp;the&nbsp;"table"&nbsp;parameter<br>
matching&nbsp;"wild".&nbsp;&nbsp;If&nbsp;wild&nbsp;is&nbsp;empty&nbsp;or&nbsp;NULL&nbsp;then<br>
a&nbsp;list&nbsp;of&nbsp;all&nbsp;columns&nbsp;will&nbsp;be&nbsp;returned.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnName"><strong>getColumnName</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;the&nbsp;name&nbsp;of&nbsp;column&nbsp;number&nbsp;col.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnNames"><strong>getColumnNames</strong></a>(self)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;column&nbsp;names&nbsp;in&nbsp;the&nbsp;current&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnPrecision"><strong>getColumnPrecision</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;the&nbsp;precision&nbsp;of&nbsp;the&nbsp;specified&nbsp;column.<br>
Precision&nbsp;is&nbsp;the&nbsp;total&nbsp;number&nbsp;of&nbsp;digits&nbsp;in&nbsp;a&nbsp;number.<br>
eg:&nbsp;123.45&nbsp;has&nbsp;a&nbsp;precision&nbsp;of&nbsp;5.&nbsp;&nbsp;For&nbsp;non-numeric<br>
types,&nbsp;it's&nbsp;the&nbsp;number&nbsp;of&nbsp;characters&nbsp;in&nbsp;the&nbsp;string.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnScale"><strong>getColumnScale</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;the&nbsp;scale&nbsp;of&nbsp;the&nbsp;specified&nbsp;column.&nbsp;&nbsp;Scale&nbsp;is<br>
the&nbsp;total&nbsp;number&nbsp;of&nbsp;digits&nbsp;to&nbsp;the&nbsp;right&nbsp;of&nbsp;the&nbsp;decimal<br>
point&nbsp;in&nbsp;a&nbsp;number.&nbsp;&nbsp;eg:&nbsp;123.45&nbsp;has&nbsp;a&nbsp;scale&nbsp;of&nbsp;2.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getColumnType"><strong>getColumnType</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;the&nbsp;type&nbsp;of&nbsp;the&nbsp;specified&nbsp;column.&nbsp;&nbsp;col&nbsp;may<br>
be&nbsp;a&nbsp;name&nbsp;or&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getDatabaseList"><strong>getDatabaseList</strong></a>(self, wild)</dt><dd><tt>Sends&nbsp;a&nbsp;query&nbsp;that&nbsp;returns&nbsp;a&nbsp;list&nbsp;of<br>
databases/schemas&nbsp;matching&nbsp;"wild".&nbsp;&nbsp;If&nbsp;wild&nbsp;is&nbsp;empty<br>
or&nbsp;NULL&nbsp;then&nbsp;a&nbsp;list&nbsp;of&nbsp;all&nbsp;databases/schemas&nbsp;will&nbsp;be<br>
returned.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getField"><strong>getField</strong></a>(self, row, col)</dt><dd><tt>Returns&nbsp;the&nbsp;value&nbsp;of&nbsp;the&nbsp;specified&nbsp;row&nbsp;and<br>
column.&nbsp;&nbsp;col&nbsp;may&nbsp;be&nbsp;a&nbsp;column&nbsp;name&nbsp;or&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getFieldAsDouble"><strong>getFieldAsDouble</strong></a>(self, row, col)</dt><dd><tt>Returns&nbsp;the&nbsp;specified&nbsp;field&nbsp;as&nbsp;a&nbsp;double&nbsp;precision<br>
floating&nbsp;point&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getFieldAsInteger"><strong>getFieldAsInteger</strong></a>(self, row, col)</dt><dd><tt>Returns&nbsp;the&nbsp;specified&nbsp;field&nbsp;as&nbsp;a&nbsp;long&nbsp;integer.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getFieldLength"><strong>getFieldLength</strong></a>(self, row, col)</dt><dd><tt>Returns&nbsp;the&nbsp;length&nbsp;of&nbsp;the&nbsp;specified&nbsp;row&nbsp;and<br>
column.&nbsp;&nbsp;col&nbsp;may&nbsp;be&nbsp;a&nbsp;column&nbsp;name&nbsp;or&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getLongest"><strong>getLongest</strong></a>(self, col)</dt><dd><tt>Returns&nbsp;the&nbsp;length&nbsp;of&nbsp;the&nbsp;specified&nbsp;column.&nbsp;&nbsp;col&nbsp;may<br>
be&nbsp;a&nbsp;name&nbsp;or&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getNullsAsEmptyStrings"><strong>getNullsAsEmptyStrings</strong></a>(self)</dt><dd><tt>Tells&nbsp;the&nbsp;cursor&nbsp;to&nbsp;return&nbsp;NULL&nbsp;fields&nbsp;and&nbsp;output<br>
bind&nbsp;variables&nbsp;as&nbsp;empty&nbsp;strings.<br>
This&nbsp;is&nbsp;the&nbsp;default.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getNullsAsNone"><strong>getNullsAsNone</strong></a>(self)</dt><dd><tt>Tells&nbsp;the&nbsp;cursor&nbsp;to&nbsp;return&nbsp;NULL&nbsp;fields&nbsp;and&nbsp;output<br>
bind&nbsp;variables&nbsp;as&nbsp;NULL's.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindBlob"><strong>getOutputBindBlob</strong></a>(self, variable)</dt><dd><tt>Get&nbsp;the&nbsp;value&nbsp;stored&nbsp;in&nbsp;a&nbsp;previously<br>
defined&nbsp;output&nbsp;bind&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindClob"><strong>getOutputBindClob</strong></a>(self, variable)</dt><dd><tt>Get&nbsp;the&nbsp;value&nbsp;stored&nbsp;in&nbsp;a&nbsp;previously<br>
defined&nbsp;output&nbsp;bind&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindCursor"><strong>getOutputBindCursor</strong></a>(self, variable)</dt><dd><tt>Get&nbsp;the&nbsp;cursor&nbsp;associated&nbsp;with&nbsp;a&nbsp;previously<br>
defined&nbsp;output&nbsp;bind&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindDouble"><strong>getOutputBindDouble</strong></a>(self, variable)</dt><dd><tt>Get&nbsp;the&nbsp;value&nbsp;stored&nbsp;in&nbsp;a&nbsp;previously<br>
defined&nbsp;output&nbsp;bind&nbsp;variable&nbsp;as&nbsp;a&nbsp;double<br>
precision&nbsp;floating&nbsp;point&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindInteger"><strong>getOutputBindInteger</strong></a>(self, variable)</dt><dd><tt>Get&nbsp;the&nbsp;value&nbsp;stored&nbsp;in&nbsp;a&nbsp;previously<br>
defined&nbsp;output&nbsp;bind&nbsp;variable&nbsp;as&nbsp;a&nbsp;long<br>
integer.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindLength"><strong>getOutputBindLength</strong></a>(self, variable)</dt><dd><tt>Retrieve&nbsp;the&nbsp;length&nbsp;of&nbsp;an&nbsp;output&nbsp;bind&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getOutputBindString"><strong>getOutputBindString</strong></a>(self, variable)</dt><dd><tt>Get&nbsp;the&nbsp;value&nbsp;stored&nbsp;in&nbsp;a&nbsp;previously<br>
defined&nbsp;output&nbsp;bind&nbsp;variable.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getResultSetBufferSize"><strong>getResultSetBufferSize</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;number&nbsp;of&nbsp;result&nbsp;set&nbsp;rows&nbsp;that&nbsp;<br>
will&nbsp;be&nbsp;buffered&nbsp;at&nbsp;a&nbsp;time&nbsp;or&nbsp;0&nbsp;for&nbsp;the<br>
entire&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getResultSetId"><strong>getResultSetId</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;internal&nbsp;ID&nbsp;of&nbsp;this&nbsp;result&nbsp;set.<br>
This&nbsp;parameter&nbsp;may&nbsp;be&nbsp;passed&nbsp;to&nbsp;another&nbsp;<br>
cursor&nbsp;for&nbsp;use&nbsp;in&nbsp;the&nbsp;<a href="#sqlrcursor-resumeResultSet">resumeResultSet</a>()&nbsp;<br>
method.<br>
Note:&nbsp;the&nbsp;value&nbsp;returned&nbsp;by&nbsp;this&nbsp;method&nbsp;is<br>
only&nbsp;valid&nbsp;after&nbsp;a&nbsp;call&nbsp;to&nbsp;<a href="#sqlrcursor-suspendResultSet">suspendResultSet</a>().</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getRow"><strong>getRow</strong></a>(self, row)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;values&nbsp;in&nbsp;the&nbsp;given&nbsp;row.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getRowDictionary"><strong>getRowDictionary</strong></a>(self, row)</dt><dd><tt>Returns&nbsp;the&nbsp;requested&nbsp;row&nbsp;as&nbsp;values&nbsp;in&nbsp;a&nbsp;dictionary<br>
with&nbsp;column&nbsp;names&nbsp;for&nbsp;keys.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getRowLengths"><strong>getRowLengths</strong></a>(self, row)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;lengths&nbsp;in&nbsp;the&nbsp;given&nbsp;row.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getRowLengthsDictionary"><strong>getRowLengthsDictionary</strong></a>(self, row)</dt><dd><tt>Returns&nbsp;the&nbsp;requested&nbsp;row&nbsp;lengths&nbsp;as&nbsp;values&nbsp;in&nbsp;a&nbsp;dictionary<br>
with&nbsp;column&nbsp;names&nbsp;for&nbsp;keys.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getRowLengthsRange"><strong>getRowLengthsRange</strong></a>(self, beg, end)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;lists&nbsp;of&nbsp;the&nbsp;lengths&nbsp;of&nbsp;rows&nbsp;between&nbsp;beg&nbsp;and&nbsp;end.<br>
Note:&nbsp;this&nbsp;function&nbsp;has&nbsp;no&nbsp;equivalent&nbsp;in&nbsp;other&nbsp;SQL&nbsp;Relay&nbsp;API's.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getRowRange"><strong>getRowRange</strong></a>(self, beg, end)</dt><dd><tt>Returns&nbsp;a&nbsp;list&nbsp;of&nbsp;lists&nbsp;of&nbsp;the&nbsp;rows&nbsp;between&nbsp;beg&nbsp;and&nbsp;end.<br>
Note:&nbsp;this&nbsp;function&nbsp;has&nbsp;no&nbsp;equivalent&nbsp;in&nbsp;other&nbsp;SQL&nbsp;Relay&nbsp;API's.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-getTableList"><strong>getTableList</strong></a>(self, wild)</dt><dd><tt>Sends&nbsp;a&nbsp;query&nbsp;that&nbsp;returns&nbsp;a&nbsp;list&nbsp;of&nbsp;tables<br>
matching&nbsp;"wild".&nbsp;&nbsp;If&nbsp;wild&nbsp;is&nbsp;empty&nbsp;or&nbsp;NULL&nbsp;then<br>
a&nbsp;list&nbsp;of&nbsp;all&nbsp;tables&nbsp;will&nbsp;be&nbsp;returned.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-inputBind"><strong>inputBind</strong></a>(self, variable, value, precision=0, scale=0)</dt><dd><tt>Define&nbsp;an&nbsp;input&nbsp;bind&nbsp;varaible.<br>
Returns&nbsp;true&nbsp;if&nbsp;the&nbsp;variable&nbsp;was&nbsp;successfully&nbsp;bound&nbsp;or&nbsp;false&nbsp;if&nbsp;the<br>
variable&nbsp;isn't&nbsp;a&nbsp;string,&nbsp;integer&nbsp;or&nbsp;decimal.&nbsp;&nbsp;If&nbsp;the&nbsp;value&nbsp;is&nbsp;a&nbsp;decimal<br>
then&nbsp;precision&nbsp;and&nbsp;scale&nbsp;may&nbsp;also&nbsp;be&nbsp;specified.&nbsp;&nbsp;If&nbsp;you&nbsp;don't&nbsp;have&nbsp;the<br>
precision&nbsp;and&nbsp;scale&nbsp;then&nbsp;set&nbsp;them&nbsp;both&nbsp;to&nbsp;0.&nbsp;&nbsp;However&nbsp;in&nbsp;that&nbsp;case&nbsp;you<br>
may&nbsp;get&nbsp;unexpected&nbsp;rounding&nbsp;behavior&nbsp;if&nbsp;the&nbsp;server&nbsp;is&nbsp;faking&nbsp;binds.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-inputBindBlob"><strong>inputBindBlob</strong></a>(self, variable, value, length)</dt><dd><tt>Define&nbsp;an&nbsp;input&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-inputBindClob"><strong>inputBindClob</strong></a>(self, variable, value, length)</dt><dd><tt>Define&nbsp;an&nbsp;input&nbsp;bind&nbsp;varaible.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-inputBinds"><strong>inputBinds</strong></a>(self, variables, values, precisions=None, scales=None)</dt><dd><tt>Define&nbsp;input&nbsp;bind&nbsp;variables.<br>
Returns&nbsp;true&nbsp;if&nbsp;the&nbsp;variables&nbsp;were&nbsp;successfully&nbsp;bound&nbsp;or&nbsp;false&nbsp;if&nbsp;one<br>
of&nbsp;the&nbsp;variables&nbsp;wasn't&nbsp;a&nbsp;string,&nbsp;integer&nbsp;or&nbsp;floating&nbsp;point&nbsp;number,<br>
or&nbsp;if&nbsp;precision&nbsp;and&nbsp;scale&nbsp;weren't&nbsp;provided&nbsp;for&nbsp;a&nbsp;floating&nbsp;point&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-lowerCaseColumnNames"><strong>lowerCaseColumnNames</strong></a>(self)</dt><dd><tt>Columns&nbsp;names&nbsp;are&nbsp;converted&nbsp;to&nbsp;lower&nbsp;case.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-mixedCaseColumnNames"><strong>mixedCaseColumnNames</strong></a>(self)</dt><dd><tt>Columns&nbsp;names&nbsp;are&nbsp;returned&nbsp;in&nbsp;the&nbsp;same<br>
case&nbsp;as&nbsp;they&nbsp;are&nbsp;defined&nbsp;in&nbsp;the&nbsp;database.<br>
This&nbsp;is&nbsp;the&nbsp;default.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-openCachedResultSet"><strong>openCachedResultSet</strong></a>(self, filename)</dt><dd><tt>Open&nbsp;a&nbsp;result&nbsp;set&nbsp;after&nbsp;a&nbsp;sendCachedQeury</tt></dd></dl>

<dl><dt><a name="sqlrcursor-prepareFileQuery"><strong>prepareFileQuery</strong></a>(self, path, file)</dt><dd><tt>Prepare&nbsp;to&nbsp;execute&nbsp;the&nbsp;contents&nbsp;of&nbsp;path/filename.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-prepareQuery"><strong>prepareQuery</strong></a>(self, query)</dt><dd><tt>Prepare&nbsp;to&nbsp;execute&nbsp;query.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-prepareQueryWithLength"><strong>prepareQueryWithLength</strong></a>(self, query, length)</dt><dd><tt>Prepare&nbsp;to&nbsp;execute&nbsp;"query"&nbsp;with&nbsp;length&nbsp;<br>
"length".&nbsp;&nbsp;This&nbsp;method&nbsp;must&nbsp;be&nbsp;used&nbsp;if&nbsp;the<br>
query&nbsp;contains&nbsp;binary&nbsp;data.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-resumeCachedResultSet"><strong>resumeCachedResultSet</strong></a>(self, id, filename)</dt><dd><tt>Resumes&nbsp;a&nbsp;result&nbsp;set&nbsp;previously&nbsp;left&nbsp;open<br>
using&nbsp;suspendSession()&nbsp;and&nbsp;continues&nbsp;caching<br>
the&nbsp;result&nbsp;set&nbsp;to&nbsp;"filename".<br>
Returns&nbsp;1&nbsp;on&nbsp;success&nbsp;and&nbsp;0&nbsp;on&nbsp;failure.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-resumeResultSet"><strong>resumeResultSet</strong></a>(self, id)</dt><dd><tt>Resumes&nbsp;a&nbsp;result&nbsp;set&nbsp;previously&nbsp;left&nbsp;open&nbsp;<br>
using&nbsp;suspendSession().<br>
Returns&nbsp;1&nbsp;on&nbsp;success&nbsp;and&nbsp;0&nbsp;on&nbsp;failure.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-rowCount"><strong>rowCount</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;in&nbsp;the&nbsp;current&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-sendFileQuery"><strong>sendFileQuery</strong></a>(self, path, file)</dt><dd><tt>Send&nbsp;the&nbsp;SQL&nbsp;query&nbsp;in&nbsp;path/file&nbsp;to&nbsp;the&nbsp;server&nbsp;and<br>
gets&nbsp;a&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-sendQuery"><strong>sendQuery</strong></a>(self, query)</dt><dd><tt>Send&nbsp;a&nbsp;SQL&nbsp;query&nbsp;to&nbsp;the&nbsp;server&nbsp;and<br>
gets&nbsp;a&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-sendQueryWithLength"><strong>sendQueryWithLength</strong></a>(self, query, length)</dt><dd><tt>Sends&nbsp;"query"&nbsp;with&nbsp;length&nbsp;"length"&nbsp;and&nbsp;gets<br>
a&nbsp;result&nbsp;set.&nbsp;This&nbsp;method&nbsp;must&nbsp;be&nbsp;used&nbsp;if<br>
the&nbsp;query&nbsp;contains&nbsp;binary&nbsp;data.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-setCacheTtl"><strong>setCacheTtl</strong></a>(self, ttl)</dt><dd><tt>Sets&nbsp;the&nbsp;time-to-live&nbsp;for&nbsp;cached&nbsp;result<br>
sets.&nbsp;The&nbsp;sqlr-cachemanger&nbsp;will&nbsp;remove&nbsp;each&nbsp;<br>
cached&nbsp;result&nbsp;set&nbsp;"ttl"&nbsp;seconds&nbsp;after&nbsp;it's&nbsp;<br>
created.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-setResultSetBufferSize"><strong>setResultSetBufferSize</strong></a>(self, rows)</dt><dd><tt>Sets&nbsp;the&nbsp;number&nbsp;of&nbsp;rows&nbsp;of&nbsp;the&nbsp;result&nbsp;set<br>
to&nbsp;buffer&nbsp;at&nbsp;a&nbsp;time.&nbsp;&nbsp;0&nbsp;(the&nbsp;default)<br>
means&nbsp;buffer&nbsp;the&nbsp;entire&nbsp;result&nbsp;set.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-substitution"><strong>substitution</strong></a>(self, variable, value, precision=0, scale=0)</dt><dd><tt>Define&nbsp;a&nbsp;substitution&nbsp;variable.<br>
Returns&nbsp;true&nbsp;if&nbsp;the&nbsp;variable&nbsp;was&nbsp;successfully&nbsp;substituted&nbsp;or&nbsp;false&nbsp;if<br>
the&nbsp;variable&nbsp;isn't&nbsp;a&nbsp;string,&nbsp;integer&nbsp;or&nbsp;floating&nbsp;point&nbsp;number,&nbsp;or&nbsp;if<br>
precision&nbsp;and&nbsp;scale&nbsp;aren't&nbsp;provided&nbsp;for&nbsp;a&nbsp;floating&nbsp;point&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-substitutions"><strong>substitutions</strong></a>(self, variables, values, precisions=None, scales=None)</dt><dd><tt>Define&nbsp;substitution&nbsp;variables.<br>
Returns&nbsp;true&nbsp;if&nbsp;the&nbsp;variables&nbsp;were&nbsp;successfully&nbsp;substituted&nbsp;or&nbsp;false&nbsp;if<br>
one&nbsp;of&nbsp;the&nbsp;variables&nbsp;wasn't&nbsp;a&nbsp;string,&nbsp;integer&nbsp;or&nbsp;floating&nbsp;point&nbsp;number,<br>
or&nbsp;if&nbsp;precision&nbsp;and&nbsp;scale&nbsp;weren't&nbsp;provided&nbsp;for&nbsp;a&nbsp;floating&nbsp;point&nbsp;number.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-suspendResultSet"><strong>suspendResultSet</strong></a>(self)</dt><dd><tt>Tells&nbsp;the&nbsp;server&nbsp;to&nbsp;leave&nbsp;this&nbsp;result<br>
set&nbsp;open&nbsp;when&nbsp;the&nbsp;cursor&nbsp;calls&nbsp;<br>
suspendSession()&nbsp;so&nbsp;that&nbsp;another&nbsp;cursor&nbsp;can&nbsp;<br>
connect&nbsp;to&nbsp;it&nbsp;using&nbsp;<a href="#sqlrcursor-resumeResultSet">resumeResultSet</a>()&nbsp;after&nbsp;<br>
it&nbsp;calls&nbsp;resumeSession().</tt></dd></dl>

<dl><dt><a name="sqlrcursor-totalRows"><strong>totalRows</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;total&nbsp;number&nbsp;of&nbsp;rows&nbsp;that&nbsp;will&nbsp;<br>
be&nbsp;returned&nbsp;in&nbsp;the&nbsp;result&nbsp;set.&nbsp;&nbsp;Not&nbsp;all&nbsp;<br>
databases&nbsp;support&nbsp;this&nbsp;call.&nbsp;&nbsp;Don't&nbsp;use&nbsp;it&nbsp;<br>
for&nbsp;applications&nbsp;which&nbsp;are&nbsp;designed&nbsp;to&nbsp;be&nbsp;<br>
portable&nbsp;across&nbsp;databases.&nbsp;&nbsp;-1&nbsp;is&nbsp;returned<br>
by&nbsp;databases&nbsp;which&nbsp;don't&nbsp;support&nbsp;this&nbsp;option.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-upperCaseColumnNames"><strong>upperCaseColumnNames</strong></a>(self)</dt><dd><tt>Columns&nbsp;names&nbsp;are&nbsp;converted&nbsp;to&nbsp;upper&nbsp;case.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-validBind"><strong>validBind</strong></a>(self, variable)</dt><dd><tt>Returns&nbsp;true&nbsp;if&nbsp;"variable"&nbsp;was&nbsp;a&nbsp;valid<br>
input&nbsp;bind&nbsp;variable&nbsp;of&nbsp;the&nbsp;query.</tt></dd></dl>

<dl><dt><a name="sqlrcursor-validateBinds"><strong>validateBinds</strong></a>(self)</dt><dd><tt>If&nbsp;you&nbsp;are&nbsp;binding&nbsp;to&nbsp;any&nbsp;variables&nbsp;that&nbsp;<br>
might&nbsp;not&nbsp;actually&nbsp;be&nbsp;in&nbsp;your&nbsp;query,&nbsp;call&nbsp;<br>
this&nbsp;to&nbsp;ensure&nbsp;that&nbsp;the&nbsp;database&nbsp;won't&nbsp;try&nbsp;<br>
to&nbsp;bind&nbsp;them&nbsp;unless&nbsp;they&nbsp;really&nbsp;are&nbsp;in&nbsp;the&nbsp;<br>
query.</tt></dd></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
    
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt><a name="-getNumericFieldsAsNumbers"><strong>getNumericFieldsAsNumbers</strong></a>()</dt><dd><tt>Instructs&nbsp;the&nbsp;API&nbsp;to&nbsp;return&nbsp;numeric&nbsp;fields&nbsp;as&nbsp;numbers.&nbsp;&nbsp;Integer&nbsp;fields&nbsp;will<br>
be&nbsp;returned&nbsp;as&nbsp;integers&nbsp;and&nbsp;floating&nbsp;point&nbsp;fields&nbsp;will&nbsp;be&nbsp;returned&nbsp;as<br>
Decimals&nbsp;if&nbsp;that&nbsp;class&nbsp;is&nbsp;avialable&nbsp;or&nbsp;floats&nbsp;otherwise.&nbsp;&nbsp;The&nbsp;drawback&nbsp;to<br>
using&nbsp;numerics&nbsp;is&nbsp;that&nbsp;under&nbsp;some&nbsp;circumstances&nbsp;truncation&nbsp;can&nbsp;occur.</tt></dd></dl>
 <dl><dt><a name="-getNumericFieldsAsStrings"><strong>getNumericFieldsAsStrings</strong></a>()</dt><dd><tt>Instructs&nbsp;the&nbsp;API&nbsp;to&nbsp;return&nbsp;numeric&nbsp;fields&nbsp;as&nbsp;strings.&nbsp;&nbsp;This&nbsp;is&nbsp;the<br>
default&nbsp;setting.&nbsp;&nbsp;Truncation&nbsp;cannot&nbsp;occur&nbsp;if&nbsp;this&nbsp;setting&nbsp;is&nbsp;used.</tt></dd></dl>
</td></tr></table>
</body></html>